home *** CD-ROM | disk | FTP | other *** search
/ CD Actual 1 / PC Actual CD 01.iso / share / dos / graficos / povray / povshell.arj / POVSHELL.HLP (.txt) < prev    next >
Encoding:
Borland Turbo Vision Help  |  1994-01-18  |  26.7 KB  |  561 lines

  1.  PovShell Version 2.0 
  2.      Welcome to PovShell -  
  3.   The Development Environment 
  4.     to the POV-Raytracer!
  5. You can reach the Top-menu by the F10-key. To select a special Top-menu- item press the Alt-key and the key with that letter which is highlighted in the item-name, e.g. press Alt-F to pull down the 'File'-menu. 
  6. You may press F1 at any time to get context-sensitive help. For further information on how to use Help read the Help
  7. Help. 8
  8. For a complete list of Help topics refer to the Index. 
  9.  Dragmode 
  10. Use the Cursor-keys to drag the window around and Shift + Cursor-keys to resize it. 
  11. See also: Windows
  12. Size/Move 
  13.  How to use Help 
  14. Use the cursor-keys and PgUp/PgDn to scroll through the Help text. 
  15. Some words of the text may be appear in yellow. These are cross-references to other help topics. Use the TAB-key to highlight these keywords, then press ENTER to switch to that topic. 
  16. Like the editor-windows Help-windows may be resized, zoomed and moved across the screen (see the help on the Windows-command). 3
  17. For a list of all help topics refer to the Index. 
  18.  The Editor 
  19. The Editor uses WordStar-compatible keys. Here is a complete list: )
  20.   Cursor-movement:
  21.    Up         or Ctrl-E:   one line up
  22.    Down       or Ctrl-X:   one line down
  23.    Left       or Ctrl-S:   one column left
  24.    Right      or Ctrl-D:   one column right
  25.    PgUp       or Ctrl-R:   one page up
  26.    PgDown     or Ctrl-C:   one page down
  27.    Ctrl-Left  or Ctrl-A:   one word left
  28.    Ctrl-Right or Ctrl-F:   one word right
  29.    Home       or Ctrl-Q-S: go to line start
  30.    End        or Ctrl-Q-D: go to the end of the line
  31.    Ctrl-PgUp  or Ctrl-Q-R: go to the top of the text
  32.    Ctrl-PGDn  or Ctrl-Q-C: go to the end of the text
  33.   Delete-keys:
  34.    Delete    or Ctrl-G:   delete character under the cursor
  35.    Backspace or Ctrl-H:   delete character left of the cursor
  36.                 Ctrl-T:   delete word beginning at cursor position
  37.                 Ctrl-Y:   delete actual line
  38.                 Ctrl-Q-H: delete line up to cursor
  39.                 Ctrl-Q-Y: delete line beginning at cursor
  40.   Block keys:
  41.                 Ctrl-K-B: activate select mode
  42.    Shift-Ins or Ctrl-K-C: paste block from Clipboard
  43.                 Ctrl-K-H: toggle block-highlight
  44.    Ctrl-Ins  or Ctrl-K-K: copy block to Clipboard
  45.    Ctrl-Del  or Ctrl-K-Y: cut block to Clipboard
  46.   Other keys:
  47.    Ins   or Ctrl-V:   toggle Insert mode
  48.    Enter or Ctrl-M:   new line
  49.             Ctrl-Q-A: replace a text string
  50.             Ctrl-Q-F: find a string
  51.             Ctrl-L:   search again
  52.             Ctrl-U:   undo
  53. You may insert PovRay-command templates in the current text at the actual cursor position by selecting the Template-Command of the Top- menu. Or press Alt-M. 
  54. Other key combinations have nothing to do with editing but let you control the PovRay- options which is normally done by using the Top-menu-item Options. They are called the 
  55.   Option keys:
  56.    Ctrl-O-A: AntiAliasing
  57.    Ctrl-O-B: Buffersize
  58.    Ctrl-O-C: Continue
  59.    Ctrl-O-D: Display-Adapter
  60.    Ctrl-O-E: End-Row/-Column
  61.    Ctrl-O-F: Outputformat
  62.    Ctrl-O-H: ImageHeight
  63.    Ctrl-O-J: AAJitter
  64.    Ctrl-O-K: Clock-Value
  65.    Ctrl-O-L: Library-paths
  66.    Ctrl-O-M: Bounding slabs
  67.    Ctrl-O-P: Pause when finished
  68.    Ctrl-O-Q: Quality
  69.    Ctrl-O-R: Number of AA-rays (to be squared)
  70.    Ctrl-O-S: Start-Row/-Column
  71.    Ctrl-O-V: Verbose
  72.    Ctrl-O-W: Image Width
  73.    Ctrl-O-X: Allow early exit
  74. Finally you can influence the size and position of the editor-windows by using the Windows- commands. 
  75.  File 
  76.   (Alt-F) 
  77. Use the 'File'-menu to execute file-related commands. It consists of the following items: R
  78.   Open a file   New file
  79.   Save file     Save
  80. as...
  81.   DOS
  82. Shell     Exit program
  83.  Edit 
  84.   (Alt-E) 
  85. The 'Edit'-menu consists of the following items: P
  86.     Undo             Cut
  87.     Copy             Paste
  88.     Show
  89. Clipboard   Clear
  90. Except of 'Show clipboard' these commands may also be executed by certain keystrokes (see Editor). 
  91.  Search 
  92.   (Alt-S) 
  93. The 'Search'-menu is for finding or replacing strings in your text. It consists of the items  
  94.  Find   Replace   Search
  95. Again
  96.  Windows 
  97.   (Alt-W) 
  98. The 'Window'-menu contains commands concerning windows like closing or moving them. 
  99. Note that you can perform most of these tasks by using hotkeys or by mouse-clicking on the window symbols ( [
  100.  ). T
  101.  Size/Move        Zoom
  102.  Tile             Cascade
  103.  Next             Previous
  104.  Close
  105.  Options 
  106.   (Alt-O) 
  107. By this menu you can control all the PovRay tracing-options and save them into DEF-files or restore them from there. s
  108. The control panels can also be reached by using the Ctrl-O Quick key (see Option keys in the Editor-description). 
  109. Control panels: 5
  110.   Output    Display
  111.   Trace     Library-paths
  112.   Misc
  113. File commands: :
  114.   Save
  115. Options    Save
  116. Default
  117. Options
  118.   Retrieve
  119. Options
  120.  Setup 
  121.   (Alt-T) 
  122. The 'Setup'-menu is for setting up the PovShell-program. For more information see the description of the menu-items $
  123.    Directories
  124.    Editor
  125.    Colors
  126.  Templates 
  127.   (Alt-M) 
  128. The 'Templates'-menu gives you a list of all the TPL-files that were found in the PovShell-directory on startup. z
  129. If you select one of the files its contents will be inserted in the current editor window at the actual cursor position. 
  130. This command was designed to have quick access to PovRay command-templates, however, you may store *any* kind of text in a TPL-file, e.g. Copyright-notes, standard headers and so on. k
  131. It is recommended that you use the editor autoindent-mode when inserting templates (see Editor
  132. settings). 
  133.  Run 
  134.   (Alt-R or Ctrl-F9)
  135. 'Run' will launch the POV-Raytracer with the POV-file you are currently editing and the tracing-options you have set. f
  136. If you have chosen to produce an output-file you will be prompted for its name in a file
  137. select
  138. box. 
  139.  About 
  140.   (Alt-A)
  141. The 'About'-box displays informations on the PovShell-program such as author, version number and release date. 
  142.  File
  143. Open... 
  144.   (F3)
  145. Use the File
  146. Open-command to open a POV-file (or any other text file) with the editor. -
  147. The command will display a File
  148. select-box. 
  149.  File
  150. This command will open a new empty and untitled editor window. 
  151.  File
  152. Save 
  153.   (F2)
  154. The File
  155. Save-command will save the file of the current editor window. If this file is still untitled Save will work exactly like Save
  156. as... 
  157.  File
  158. Save As... 
  159. This command lets you save the current editor file using a new name. You will prompted to choose the new name in a File
  160. select-box. 
  161.  File
  162. DOS Shell 
  163. The File
  164. DOS Shell-command will exit PovShell temporarily and open a DOS-shell. To leave the DOS-shell and resume the PovShell-program again enter EXIT at the DOS-prompt. 
  165.  File
  166. Exit 
  167.   (Alt-X)
  168. This command will end your PovShell session. 
  169.  Edit
  170. Undo 
  171.   (Ctrl-U)
  172. The Edit
  173. Undo-command lets you undo your last deletion/insertion. 
  174.  Edit
  175.   (Shift-Del)
  176. The Cut-command deletes the selected text block from the file and places it in the Clipboard. "
  177. See also Edit
  178. Copy    Edit
  179. Paste *
  180.          Edit
  181. Clear   Edit
  182. Clipboard
  183.  Edit
  184. Copy 
  185.   (Ctrl-Ins)
  186. The Copy-command copy the selected text block to the Clipboard. "
  187. See also Edit
  188. Cut     Edit
  189. Paste *
  190.          Edit
  191. Clear   Edit
  192. Clipboard
  193.  Edit
  194. Paste 
  195.   (Shift-Ins)
  196. The Paste-command will insert a text block from the Clipboard to the current editor window. !
  197. See also Edit
  198. Cut     Edit
  199. Copy *
  200.          Edit
  201. Clear   Edit
  202. Clipboard
  203.  Edit
  204. Show Clipboard 
  205. This command will show you a special editor window which is reserved for interchanging text blocks between multiple file editor windows. It is normally hidden and may be accessed by the following commands: 5
  206.    Edit
  207. Cut     Edit
  208.    Edit
  209. Paste   Edit
  210.  Edit
  211. Clear 
  212.   (Ctrl-Del)
  213. This command will clear the selected text from your file. c
  214. Attention: The text block will *not* be moved to the Clipboard, Undo will *not* work after Clear! 
  215.  Search
  216. Find... 
  217.   (Ctrl-Q-F)
  218. In the Search
  219. Find-dialogbox you may specify a text string to be find in the current text and options to influence the search. 3
  220. The dialogbox consists of the following elements: c
  221.     Text to find
  222.                      
  223. Enter the text to be found in this inputline. 
  224.    [ ] Case sensitive
  225. Mark this checkbox if you want to distinguish between uppercase and lowercase. 
  226.    [ ] Whole words only
  227. Mark this checkbox if you only want to search for whole words. Example: If you are searching for the string 'light' and have this checkbox marked the string 'light' will be found but not the string 'light_source'. 
  228.  Search
  229. Replace... 
  230.   (Ctrl-Q-A)
  231. In the Search
  232. Replace-dialogbox you may specify a string to be found and replaced by another string. 3
  233. The dialogbox consists of the following elements: c
  234.     Text to find
  235.                      
  236. Enter the text to be replaced in this inputline. _
  237.     New text
  238.                      
  239. Enter the new text in this inputline. You can also leave this line blank to delete the occurence(s) of the search strings. 
  240.    [ ] Case sensitive
  241. Mark this checkbox if you want to distinguish between uppercase and lowercase. 
  242.    [ ] Whole words only
  243. Mark this checkbox if you only want to replace whole words. Example: If you are replacing for the string 'light' and have this checkbox marked the string 'light' will be replaced but not the string 'light_source'. 
  244.    [X] Prompt on replace
  245. Mark this checkbox if you want to be asked each time the string is found before it is replaced. This is the default. 
  246.    [ ] Replace all
  247. Mark this checkbox if you want all matching strings to be replaced. By default only the first occurence of the string will be replaced. 
  248.  Search
  249. Search Again 
  250.   (Ctrl-L)
  251. This command will repeat the last Find- or Replace-command. 
  252.  Window
  253. Size/Move 
  254.   (Ctrl-F5)
  255. By this command you can change the size and position of the current window. 
  256.   Size
  257. By using the cursor-keys while holding down the shift-key you change the size of the active window. {
  258. If the active window has got a mouse corner (
  259. ) you can also use the mouse to resize the window by dragging this corner. 
  260.   Move
  261. By using the cursor-keys after selecting the Window
  262. Size/Move-command you move the window across the screen. Press Enter to confirm the new position and finish moving/resizing. H
  263. You can also use the mouse to move a window by dragging its title bar. 
  264.  Window
  265. Zoom 
  266.   (F5)
  267. The Zoom-command will expand the active window to its maximum size, resp. will restore its original size if it has already been expanded. 
  268. This can also be done by double-clicking on the window's title bar or by clicking on the symbols [
  269. ] resp. [
  270. ] in the upper right corner of the window. 
  271.  Window
  272. Tile 
  273. After tiling the editor-windows you will see them altogether on the screen. L
  274.                
  275.                
  276.                
  277.                
  278.                
  279.                
  280.                
  281.                
  282.                
  283.                
  284.                
  285.                
  286.                
  287.                
  288.                
  289.                
  290.              Tiled windows
  291.  Window
  292. Cascade 
  293. The Window
  294. Cascade-command will stack all the editor windows beginning in the upper left corner. Y
  295.                          
  296.                          
  297.                          
  298.                          
  299.                          
  300.         Stacked windows
  301.  Window
  302. Next 
  303.   (F6)
  304. By 'Next' you select the next editor window. 
  305.  Window
  306. Previous 
  307.   (Shift-F6)
  308. By 'Previous' you select the previous editor window. 
  309.  Window
  310. Close 
  311.   (Alt-F3)
  312. This command will close the active window. u
  313. You can also use the mouse to do this by clicking on the close-button ([
  314. ]) in the upper left corner of the window. 
  315.  Options
  316. Output... 
  317. In the Options
  318. Output-dialogbox you can control all the PovRay-options that deal with the production of an outputfile. 
  319.   Format
  320. These radiobuttons control the format of the output: 
  321.   ( ) none  : no outputfile
  322. ) TGA   : 24-bit Targa format
  323.               (This is the default)
  324.   ( ) Dump  : The Atari DIS format
  325.   ( ) RAW   : produces 3 outputfiles
  326.               with the extensions
  327.               .R8, .G8 and B8
  328.   Continue
  329. Control the continuation of an aborted trace with these radiobuttons: 
  330.   ( ) yes   : If the output-file already exists
  331.               PovRay will assume that an aborted
  332.               trace is to be continued
  333. ) no    : If the output-file already exists
  334.               it will be overwritten
  335.               (This is the default)
  336.   Buffersize
  337. Enter the size of the outputfile-buffer in KB here. k
  338.  Note: Entering -1 will disable buffering, entering 0
  339.        uses the default. The maximum amount is 8192.
  340.  Options
  341. Display... 
  342. In the Options
  343. Display-dialogbox you can control the PovRay-options that concern the display of the traced picture. !
  344.   Adapter
  345. Select the Display-Adapter and -mode to use with the Adapter-radiobuttons. The default is *not* to display the picture. !
  346.   Palette
  347. Select the palette model to use: <
  348. ) 332          : the standard 8 bits 256-color VGA-mode
  349.                      (this is the default)
  350.   ( ) HighColor    : 15/16 bits  32,768/65,536 colors
  351.   ( ) HSV          : use the HSV model in VGA-mode
  352.   ( ) GrayScale    : use Grayscale palette with VGA-display
  353.   ( ) TrueColor    : 24 bits  16,777,216 colors
  354.   Size/Width/Heigth
  355. Here you can control the image size. The most common adapter resolutions are directly selectable. If you want to use different values select the 'Custom'-button and enter the 'Width' and 'Height' on the appropiate input-lines. 
  356.  Options
  357. Trace... 
  358. In the Options
  359. Trace-dialogbox you can control the PovRay-options that influence the tracing process. !
  360.   Quality
  361. Values from 0 to 9 are allowed. The higher the value the better the quality. The default is the maximum 9. ?
  362.   [ ] Anti-Aliasing
  363. Mark this checkbox to enable Anti-Aliasing. The input-line following right is for controling the Anti-Aliasing amount. The lower the better. 3
  364.   [X] AA-Jitter
  365. If anti-aliasing is used jittering is also used by default with a default jittering scale of 1.0. Unmark the checkbox to disable jittering or enter a different scaling amount on the input-line following right. o
  366.   Number of AA-Rays (to be squared)
  367. For anti-aliasing a square of n x n rays is used whereas n is in the range of 1 to 9. The default value is 3 (meaning 3x3=9 rays). B
  368.   [X] Bounding Slabs
  369. Bounding slabs are enabled by default with a threshold of 25. Unmark this checkbox to prevent the use of bounding slabs or enter a different threshold on the input-line. K
  370.   Version Compatibility
  371. This checkbox is for selecting the PovRay version compatibility mode. Select V1.0 or V2.0 which is the default. 
  372.  Options
  373. Library-paths... 
  374. The Options
  375. Library-paths-dialogbox consists of a single input-line where you can enter the PovRay-library-paths. Up to 10 directories are allowed, separate them by semicolons. 
  376.  Options
  377. Misc... 
  378. In the Options
  379. Misc-dialogbox you can control all the 'miscellaneous' PovRay-options that do not fit in one of the main categories output, display, trace and Lib-paths. B
  380.   [ ] Verbose Output
  381. Mark this checkbox to enable verbose output, PovRay will then display the number of the image-line currently processed during the trace. K
  382.   [ ] Pause after trace
  383. Use this option to have PovRay wait for a keyhit after completing the trace. H
  384.   [ ] Allow early exit
  385. Marking this checkbox enables you to abort a trace by keyhit. An aborted trace may be continued later if you have produced an output-file. N
  386.   [ ] Enable clock value
  387. Mark this checkbox to pass a clock value to PovRay. Enter the value on the input-line following right. 0
  388.   Image Window
  389. If you want only a part of the image to be rendered enter the start-row/-column- and the end-row/-column-values in the appropiate input-lines. By default the whole image will be processed. 
  390.  Options
  391. Save Options... 
  392. Use the Options
  393. Save Options-command to save the currently selected PovRay-options in a standard DEF-file. You will be prompted for a filename in a file
  394. select
  395. box. 
  396. See also Retrieve
  397. options. 
  398.  Options
  399. Save Default Options 
  400. This command will save the currently selected PovRay-options in the file DEFAULT.DEF in the PovShell-directory. Each time you start PovShell it will retrieve the options stored in that file, so these values will override the PovRay default values. 
  401.  Options
  402. Retrieve Options... 
  403. Use the Options
  404. Retrieve Options-command to retrieve the PovRay-options that were once saved in a DEF-file using the Save
  405. Options-command. You will be prompted for the name of the file in a file
  406. select
  407. box. 
  408.  Setup
  409. Directories... 
  410. Here you have to specify some DOS-paths for the use with PovShell. If you are running PovShell for the very first time this dialog-box will pop up automatically. K
  411.   Default POV-file-path
  412. This is the directory where PovShell will first look for POV-files when you choose to open one using the File
  413. Open-command. Note that you can change to a different directory in the file
  414. select
  415. box. E
  416.   Default output-path
  417. This is the directory where PovShell will suggest to write the output-files. If you leave this line blank, PovShell will suggest to write the output-file to the directory where the POV-file resides. B
  418.   Path to Executable
  419. Enter the full filename of the PovRay-executable here (e.g. C:\POV\POVRAY.EXE). 
  420.  Setup
  421. Editor... 
  422. In the Setup
  423. Editor-dialogbox you can control various editor options. Q
  424.   [X] Create Backup files
  425. Mark this checkbox to make the editor create backup copies of each file you edit (i.e. change and save). The backup files will have a .BAK extension. This option is enabled by default. 9
  426.   [X] Insert Mode
  427. If this checkbox is marked the editor-cursor will be in insert-mode on startup. You may toggle between insert-mode and overwrite-mode any time by using the Ins-key or Ctrl-V. E
  428.   [ ] Autoindent mode
  429. Mark this checkbox to place the editor cursor in autoindent-mode. If you start a new line in autoindent-mode by pressing Enter the cursor will be automatically placed under the first non-blank character of the line above, so you may easily write indented paragraphs. 
  430.  Note: If you insert Templates in your
  431.        script while using the autoindent
  432.        mode the text of the templates will
  433.        also be indented.
  434.   [X] Save Desktop on exit
  435. If this option is enabled PovShell will save the filenames and positions of all open editor windows whenever you exit the program. The next time you start PovShell these informations will be used to restore the desktop, so you can immediately continue you work where you have once left off. !
  436.   TabSize
  437. Here you may control the number of blanks to display a TAB-character. Values in the range of 2 to 16 are allowed, the default is 3. 
  438. Press the OK-button or ENTER to continue! 
  439.  Yes/No/Cancel 
  440. Answer 'Yes', 'No' or 'Cancel' your request! 
  441.  OK/Cancel 
  442. Answer 'OK' to confirm or 'Cancel' your request! 
  443.  Setup
  444. Colors... 
  445. In the Setup
  446. Colors-dialogbox you can change the colors of PovShell. 
  447. Note: This command is NOT available if you have told PovShell to use the Black&White-palette by calling it with the commandline-switch '/b' ! y
  448. The dialogbox consists of two lists (groups and items), two color palettes (background and foreground) and a text area. 
  449.  Group 
  450.    Desktop           
  451.    Menues           
  452.    Dialog boxes     
  453.    Editor windows   
  454.    Help windows      
  455.                      
  456. The group list contains the names of the views whose colors can be changed. e
  457.  Item 
  458.    Color             
  459.                     
  460.                     
  461. If you choose a group from the group list its items will be shown in the itemlist. 
  462.  Foreground 
  463.  Background 
  464. Finally you can select a different fore- and background-color for each item from the palette panels. Q
  465.  Text Text Text 
  466.  Text Text Text 
  467. The current selection is shown in the sample text area. d
  468. Note: The changes you make in this dialogbox will not apply until you close it with the OK-button. 
  469.  File select box 
  470. A file select box contains a filename-inputline, a file list, an information field, an Open-button, a Cancel-button and a history-list which is assigned to the filename-inputline. |
  471.  Name 
  472.                                  
  473. In the filename-inputline enter the name of the file to be opened or a wildcard-mask for the file list (e.g. *.*). ^
  474. Use the history-list button or the Cursor-Down key to pick a filename from the history-list. 
  475.  Files 
  476.                                  
  477.   FILENM01.POV  
  478.   FILENM09.POV  
  479.   FILENM02.POV  
  480.   FILENM10.POV  
  481.   FILENM03.POV  
  482.   FILENM11.POV  
  483.   FILENM04.POV  
  484.   FILENM12.POV  
  485.   FILENM05.POV  
  486.   ..\           
  487.   FILENM06.POV  
  488.   LEVEL1\       
  489.   FILENM07.POV  
  490.   LEVEL2\       
  491.   FILENM08.POV  
  492.   LEVEL3\       
  493. The file list includes the files of the current directory, the upper directory (..) and all the sub-directories as far as their names match the current file mask. 
  494.  C:\POV\SCENES\LEVEL1\*.POV                
  495.  BALLBOX1.POV  2469  Jan  6, 1994  12:00pm 
  496. The information field displays the path, the name, the creation date and the size of the file. 4
  497.  [ Open ] 
  498.  or Enter
  499. The Open-button will open the currently selected file. If you have entered just a wildcard mask in the filename-inputline the open-button will cause the file list to be updated. ;
  500.  [ Cancel ] 
  501.  or Escape
  502. The Cancel-button cancels the current operation and removes the dialog-box. 
  503.  Help Index 
  504. Help is available on the following topics: T
  505.    About               Edit
  506.    Editor              Edit
  507. Clear
  508.    Edit
  509. Copy           Edit
  510.    Edit
  511. Paste          Edit
  512. Clipboard
  513.    Edit
  514. Undo           File
  515.    File
  516. select
  517. box     File
  518. Shell
  519.    File
  520. Exit           File
  521.    File
  522. Open           File
  523.    File
  524. As        How
  525.    Introduction        Options
  526.    Options
  527. Display     Options
  528. Library-paths
  529.    Options
  530. Misc        Options
  531. Output
  532.    Options
  533. Retrieve    Options
  534. Default
  535.    Options
  536. Save        Options
  537. Trace
  538.    Run
  539. command         Search
  540.    Search
  541. Find         Search
  542. Replace
  543.    Search
  544. Search
  545. Again Setup
  546.    Setup
  547. Colors        Setup
  548. Directories
  549.    Setup
  550. Editor        Templates
  551.    Windows
  552. menu        Window
  553. Cascade
  554.    Window
  555. Close        Window
  556.    Window
  557. Previous     Window
  558. Size/Move
  559.    Window
  560. Tile         Window
  561.